/*
 * The MIT License
 *
 * Copyright 2012 http://generic-toolset.googlecode.com.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.rlpw.swing;

import java.util.List;

/**
 * 
 * @param <T> the type of the elements
 */
public interface CheckModel<T> extends SelectionMode {

    /**
     * Returns {@code true} if the specified index is checked,
     * else {@code false}. 
     *
     * @param index index to be queried for check state
     * @return {@code true} if the specified index is checked,
     *         else {@code false}
     */
    public boolean isChecked(int index);

    /**
     * Returns {@code true} if the specified element is checked,
     * else {@code false}. 
     *
     * @param element element to be queried for check state
     * @return {@code true} if the specified element is checked,
     *         else {@code false}
     */
    public boolean isChecked(T element);

    /**
     * Checks or unchecks a specified index.
     * 
     * @param index the index of the element to check or uncheck
     * @param check {@code true} if the specified element are to be checked,
     *         else {@code false}
     */
    public void setChecked(int index, boolean check);

    /**
     * Checks or unchecks a specified element.
     * 
     * @param element the element to check or uncheck
     * @param check {@code true} if the specified element are to be checked,
     *         else {@code false}
     */
    public void setChecked(T element, boolean check);

    /**
     * Changes the states for all elements.
     * Does nothing if the {@code Mode} is {@code SINGLE}.
     * 
     * @param check {@code true} if the elements are to be checked,
     *         else {@code false}
     */
    public void setAllChecked(boolean check);

    /**
     * Returns a list of all checked items.
     *
     * @return a list of all checked items
     */
    public List<T> getChecked();

    /**
     * Returns the number of checked elements.
     *
     * @return the number of checked elements
     */
    public int countChecked();
}
